doc: fix http properties documented as methods - #12039
Conversation
- at 9772fb9 [`maxHeadersCount`][maxheaderscount] and [`timeout`][timeout] were erroneously changed to methods - `maxHeadersCount` was also listed to default to `1000` where it actually is [`2000`][default] [maxheaderscount]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276 [timeout]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273 [default]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312
`server.timeout` is a property, not a method
|
@ahmadnassri Thank you for your contribution! A nit: it seems the message of the first commit violates line length requrements. Could you wrap the lines? And maybe it is better to clean out markdown link code. So the commit message can be something like this: Or even like this (in the message of the landed commit there will be a link to this PR, so all your links will be available): |
* at 9772fb9 [`maxHeadersCount`][maxheaderscount] and [`timeout`][timeout] were erroneously changed to methods * `maxHeadersCount` was also listed to default to `1000` where it actually is [`2000`][default] [maxheaderscount]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276 [timeout]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273 [default]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312 PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
`server.timeout` is a property, not a method PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
Landed in d437841...d367a0a |
* at 9772fb9 [`maxHeadersCount`][maxheaderscount] and [`timeout`][timeout] were erroneously changed to methods * `maxHeadersCount` was also listed to default to `1000` where it actually is [`2000`][default] [maxheaderscount]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L276 [timeout]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L273 [default]: https://github.com/nodejs/node/blob/e0a9ad1af244f8756a228a6d087b3a55ee4c0d14/lib/_http_server.js#L312 PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
`server.timeout` is a property, not a method PR-URL: #12039 Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com> Reviewed-By: James M Snell <jasnell@gmail.com>
|
is this applicable to v6.x? |
|
Should this be backported to |
This is misleading, that link is referencing maxHeaderPairs which includes both keys and values, so 2000 pairs is 1000 headers. The docs at the moment are a bit misleading; you would expect to be able to send 2000 headers but anything after 1000 is silently dropped. |
Checklist
Affected core subsystem(s)
maxHeadersCountandtimeoutwere erroneously changed to methodsmaxHeadersCountwas also listed to default to1000where it actually is2000